<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <title>bn::sprite_tiles_item class | Butano Docs</title>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
  <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
  <link rel="icon" href="favicon-dark.png" type="image/png" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <meta name="theme-color" content="#22272e" />
</head>
<body>
<header><nav id="navigation">
  <div class="m-container">
    <div class="m-row">
      <span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
        <a href="https://github.com/GValiente/butano">Butano</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">Docs</a>
      </span>
      <div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
        <a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
          <path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
        </svg></a>
        <a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
        <a id="m-navbar-hide" href="#" title="Hide navigation"></a>
      </div>
      <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
        <div class="m-row">
          <ol class="m-col-t-6 m-col-m-none">
            <li><a href="pages.html">Pages</a></li>
            <li><a href="modules.html">Modules</a></li>
          </ol>
          <ol class="m-col-t-6 m-col-m-none" start="3">
            <li><a href="namespaces.html">Namespaces</a></li>
            <li><a href="annotated.html">Classes</a></li>
            <li><a href="files.html">Files</a></li>
            <li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
              <use href="#m-doc-search-icon-path" />
            </svg></a></li>
          </ol>
        </div>
      </div>
    </div>
  </div>
</nav></header>
<main><article>
  <div class="m-container m-container-inflatable">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <h1>
          <span class="m-breadcrumb"><a href="namespacebn.html">bn</a>::<wbr/></span>sprite_tiles_item <span class="m-thin">class</span>
          <div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="bn__sprite__tiles__item_8h.html">&lt;bn_sprite_tiles_item.h&gt;</a></div>
        </h1>
        <p>Contains the required information to generate sprite tiles.</p>
        <nav class="m-block m-default">
          <h3>Contents</h3>
          <ul>
            <li>
              Reference
              <ul>
                <li><a href="#pub-static-methods">Public static functions</a></li>
                <li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
                <li><a href="#pub-methods">Public functions</a></li>
                <li><a href="#friends">Friends</a></li>
              </ul>
            </li>
          </ul>
        </nav>
<p>The assets conversion tools generate an object of this type in the build folder for each *.bmp file with <code>sprite</code> type.</p><p>The tiles are not copied but referenced, so they should outlive the <a href="classbn_1_1sprite__tiles__item.html" class="m-doc">sprite_<wbr />tiles_<wbr />item</a> to avoid dangling references.</p>
        <section id="pub-static-methods">
          <h2><a href="#pub-static-methods">Public static functions</a></h2>
          <dl class="m-doc">
            <dt id="a0afe2b9ea69d93c415e80e56361b100f">
              <span class="m-doc-wrap-bumper">static auto <a href="#a0afe2b9ea69d93c415e80e56361b100f" class="m-doc-self">valid_tiles_count</a>(</span><span class="m-doc-wrap">int tiles_count,
              <a href="group__color.html#gac2f168d95746d61f442c3d3eadffc77e" class="m-doc">bpp_<wbr />mode</a> bpp) -&gt; bool <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Indicates if the specified tiles count are valid for the specified bits per pixel or not.</dd>
          </dl>
        </section>
        <section id="typeless-methods">
          <h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper"><a href="#a05b098f5b9f8861d1f124f9266051473" class="m-doc">sprite_tiles_item</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1span.html" class="m-doc">span</a>&lt;const <a href="classbn_1_1tile.html" class="m-doc">tile</a>&gt;&amp; tiles_ref,
              <a href="group__color.html#gac2f168d95746d61f442c3d3eadffc77e" class="m-doc">bpp_<wbr />mode</a> bpp) <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Constructor.</dd>
            <dt>
              <span class="m-doc-wrap-bumper"><a href="#aa387229c27ca2328d02915df0a25441d" class="m-doc">sprite_tiles_item</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1span.html" class="m-doc">span</a>&lt;const <a href="classbn_1_1tile.html" class="m-doc">tile</a>&gt;&amp; tiles_ref,
              <a href="group__color.html#gac2f168d95746d61f442c3d3eadffc77e" class="m-doc">bpp_<wbr />mode</a> bpp,
              <a href="group__tool.html#gabe5512b25aeba41d12da5c555ed129ae" class="m-doc">compression_<wbr />type</a> compression) <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Constructor.</dd>
            <dt>
              <span class="m-doc-wrap-bumper"><a href="#a0f04a79f90e787962a5fdde04a4421dd" class="m-doc">sprite_tiles_item</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1span.html" class="m-doc">span</a>&lt;const <a href="classbn_1_1tile.html" class="m-doc">tile</a>&gt;&amp; tiles_ref,
              <a href="group__color.html#gac2f168d95746d61f442c3d3eadffc77e" class="m-doc">bpp_<wbr />mode</a> bpp,
              int graphics_count) <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Constructor.</dd>
            <dt>
              <span class="m-doc-wrap-bumper"><a href="#accfc0df1a8d94c51e3be84cd617d4637" class="m-doc">sprite_tiles_item</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1span.html" class="m-doc">span</a>&lt;const <a href="classbn_1_1tile.html" class="m-doc">tile</a>&gt;&amp; tiles_ref,
              <a href="group__color.html#gac2f168d95746d61f442c3d3eadffc77e" class="m-doc">bpp_<wbr />mode</a> bpp,
              <a href="group__tool.html#gabe5512b25aeba41d12da5c555ed129ae" class="m-doc">compression_<wbr />type</a> compression,
              int graphics_count) <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Constructor.</dd>
          </dl>
        </section>
        <section id="pub-methods">
          <h2><a href="#pub-methods">Public functions</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a74b1a4546d379166790980fe2e079060" class="m-doc">tiles_ref</a>(</span><span class="m-doc-wrap">) const -&gt; const <a href="classbn_1_1span.html" class="m-doc">span</a>&lt;const <a href="classbn_1_1tile.html" class="m-doc">tile</a>&gt;&amp; <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Returns the reference to one or more sprite tile sets.</dd>
            <dt id="a7b8d2c40e10fe8ada1d3ec3e10dcf680">
              <span class="m-doc-wrap-bumper">auto <a href="#a7b8d2c40e10fe8ada1d3ec3e10dcf680" class="m-doc-self">bpp</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="group__color.html#gac2f168d95746d61f442c3d3eadffc77e" class="m-doc">bpp_<wbr />mode</a> <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Returns the bits per pixel of the referenced tiles.</dd>
            <dt id="a90a841dc80db2fd440e4def4f5cacf10">
              <span class="m-doc-wrap-bumper">auto <a href="#a90a841dc80db2fd440e4def4f5cacf10" class="m-doc-self">graphics_count</a>(</span><span class="m-doc-wrap">) const -&gt; int <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Returns the number of sprite tile sets contained in tiles_ref.</dd>
            <dt id="a7b8175006f144fea980920fa834dbdea">
              <span class="m-doc-wrap-bumper">auto <a href="#a7b8175006f144fea980920fa834dbdea" class="m-doc-self">tiles_count_per_graphic</a>(</span><span class="m-doc-wrap">) const -&gt; int <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Returns the number of sprite tiles contained in each sprite tile set.</dd>
            <dt id="a22cbdd91169e41a50bfd966be5de7192">
              <span class="m-doc-wrap-bumper">auto <a href="#a22cbdd91169e41a50bfd966be5de7192" class="m-doc-self">graphics_tiles_ref</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="classbn_1_1span.html" class="m-doc">span</a>&lt;const <a href="classbn_1_1tile.html" class="m-doc">tile</a>&gt; <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Returns the reference to the first sprite tile set.</dd>
            <dt id="a094c8b7f01da2c270ce5b72bb573c53f">
              <span class="m-doc-wrap-bumper">auto <a href="#a094c8b7f01da2c270ce5b72bb573c53f" class="m-doc-self">graphics_tiles_ref</a>(</span><span class="m-doc-wrap">int graphics_index) const -&gt; <a href="classbn_1_1span.html" class="m-doc">span</a>&lt;const <a href="classbn_1_1tile.html" class="m-doc">tile</a>&gt; <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Returns the reference to the sprite tile set indicated by graphics_index.</dd>
            <dt id="a667cff8705f6c83d18b92e0efe5d21d3">
              <span class="m-doc-wrap-bumper">auto <a href="#a667cff8705f6c83d18b92e0efe5d21d3" class="m-doc-self">compression</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="group__tool.html#gabe5512b25aeba41d12da5c555ed129ae" class="m-doc">compression_<wbr />type</a> <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Returns the compression type.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#af33926135d5c63445677aa2f226bddfe" class="m-doc">decompress</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1span.html" class="m-doc">span</a>&lt;<a href="classbn_1_1tile.html" class="m-doc">tile</a>&gt; decompressed_tiles_ref) const -&gt; <a href="classbn_1_1sprite__tiles__item.html" class="m-doc">sprite_<wbr />tiles_<wbr />item</a></span>
            </dt>
            <dd>Decompresses the stored data in the tiles referenced by decompressed_tiles_ref.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a84147ffa38fcf787912fb3a13d0008f2" class="m-doc">find_tiles</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a>&gt;</span>
            </dt>
            <dd>Searches for a <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references the first sprite tile set.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#afb930f629ebb7c6a6bb044712fede3b5" class="m-doc">find_tiles</a>(</span><span class="m-doc-wrap">int graphics_index) const -&gt; <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a>&gt;</span>
            </dt>
            <dd>Searches for a <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references the sprite tile set indicated by graphics_index.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a7a9ab6344966eb9f02fad0a7d920723a" class="m-doc">create_tiles</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a></span>
            </dt>
            <dd>Searches for a <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references the first sprite tile set. If it is not found, it creates a <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references it.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a2e53f3aee95c5e4c4e05f2c65d762658" class="m-doc">create_tiles</a>(</span><span class="m-doc-wrap">int graphics_index) const -&gt; <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a></span>
            </dt>
            <dd>Searches for a <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references the sprite tile set indicated by graphics_index. If it is not found, it creates a <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references it.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a8e86f31d8f9062ca5d7d41cbc4b74aba" class="m-doc">create_tiles_optional</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a>&gt;</span>
            </dt>
            <dd>Searches for a <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references the first sprite tile set. If it is not found, it creates a <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references it.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a96857b578fd25a0864b062b7924e293e" class="m-doc">create_tiles_optional</a>(</span><span class="m-doc-wrap">int graphics_index) const -&gt; <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a>&gt;</span>
            </dt>
            <dd>Searches for a <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references the sprite tile set indicated by graphics_index. If it is not found, it creates a <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references it.</dd>
          </dl>
        </section>
        <section id="friends">
          <h2><a href="#friends">Friends</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#ade0eefe4c5b7e63ad266afeffe0b34e0" class="m-doc">operator==</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1sprite__tiles__item.html" class="m-doc">sprite_<wbr />tiles_<wbr />item</a>&amp; a,
              const <a href="classbn_1_1sprite__tiles__item.html" class="m-doc">sprite_<wbr />tiles_<wbr />item</a>&amp; b) -&gt; bool <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Equal operator.</dd>
          </dl>
        </section>
        <section>
          <h2>Function documentation</h2>
          <section class="m-doc-details" id="a05b098f5b9f8861d1f124f9266051473"><div>
            <h3>
              <span class="m-doc-wrap-bumper"> bn::<wbr />sprite_tiles_item::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a05b098f5b9f8861d1f124f9266051473" class="m-doc-self">sprite_tiles_item</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1span.html" class="m-doc">span</a>&lt;const <a href="classbn_1_1tile.html" class="m-doc">tile</a>&gt;&amp; tiles_ref,
              <a href="group__color.html#gac2f168d95746d61f442c3d3eadffc77e" class="m-doc">bpp_<wbr />mode</a> bpp) <span class="m-label m-primary">constexpr</span></span></span>
            </h3>
            <p>Constructor.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">tiles_ref</td>
                  <td>Reference to one or more sprite tile sets.</td>
                </tr>
                <tr>
                  <td>bpp</td>
                  <td>tiles_ref bits per pixel.</td>
                </tr>
              </tbody>
            </table>
<p>The tiles are not copied but referenced, so they should outlive the <a href="classbn_1_1sprite__tiles__item.html" class="m-doc">sprite_<wbr />tiles_<wbr />item</a> to avoid dangling references.</p>
          </div></section>
          <section class="m-doc-details" id="aa387229c27ca2328d02915df0a25441d"><div>
            <h3>
              <span class="m-doc-wrap-bumper"> bn::<wbr />sprite_tiles_item::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aa387229c27ca2328d02915df0a25441d" class="m-doc-self">sprite_tiles_item</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1span.html" class="m-doc">span</a>&lt;const <a href="classbn_1_1tile.html" class="m-doc">tile</a>&gt;&amp; tiles_ref,
              <a href="group__color.html#gac2f168d95746d61f442c3d3eadffc77e" class="m-doc">bpp_<wbr />mode</a> bpp,
              <a href="group__tool.html#gabe5512b25aeba41d12da5c555ed129ae" class="m-doc">compression_<wbr />type</a> compression) <span class="m-label m-primary">constexpr</span></span></span>
            </h3>
            <p>Constructor.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">tiles_ref</td>
                  <td>Reference to one or more sprite tile sets.</td>
                </tr>
                <tr>
                  <td>bpp</td>
                  <td>tiles_ref bits per pixel.</td>
                </tr>
                <tr>
                  <td>compression</td>
                  <td>Compression type.</td>
                </tr>
              </tbody>
            </table>
<p>The tiles are not copied but referenced, so they should outlive the <a href="classbn_1_1sprite__tiles__item.html" class="m-doc">sprite_<wbr />tiles_<wbr />item</a> to avoid dangling references.</p>
          </div></section>
          <section class="m-doc-details" id="a0f04a79f90e787962a5fdde04a4421dd"><div>
            <h3>
              <span class="m-doc-wrap-bumper"> bn::<wbr />sprite_tiles_item::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a0f04a79f90e787962a5fdde04a4421dd" class="m-doc-self">sprite_tiles_item</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1span.html" class="m-doc">span</a>&lt;const <a href="classbn_1_1tile.html" class="m-doc">tile</a>&gt;&amp; tiles_ref,
              <a href="group__color.html#gac2f168d95746d61f442c3d3eadffc77e" class="m-doc">bpp_<wbr />mode</a> bpp,
              int graphics_count) <span class="m-label m-primary">constexpr</span></span></span>
            </h3>
            <p>Constructor.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">tiles_ref</td>
                  <td>Reference to one or more sprite tile sets.</td>
                </tr>
                <tr>
                  <td>bpp</td>
                  <td>tiles_ref bits per pixel.</td>
                </tr>
                <tr>
                  <td>graphics_count</td>
                  <td>Number of sprite tile sets contained in tiles_ref.</td>
                </tr>
              </tbody>
            </table>
<p>The tiles are not copied but referenced, so they should outlive the <a href="classbn_1_1sprite__tiles__item.html" class="m-doc">sprite_<wbr />tiles_<wbr />item</a> to avoid dangling references.</p>
          </div></section>
          <section class="m-doc-details" id="accfc0df1a8d94c51e3be84cd617d4637"><div>
            <h3>
              <span class="m-doc-wrap-bumper"> bn::<wbr />sprite_tiles_item::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#accfc0df1a8d94c51e3be84cd617d4637" class="m-doc-self">sprite_tiles_item</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1span.html" class="m-doc">span</a>&lt;const <a href="classbn_1_1tile.html" class="m-doc">tile</a>&gt;&amp; tiles_ref,
              <a href="group__color.html#gac2f168d95746d61f442c3d3eadffc77e" class="m-doc">bpp_<wbr />mode</a> bpp,
              <a href="group__tool.html#gabe5512b25aeba41d12da5c555ed129ae" class="m-doc">compression_<wbr />type</a> compression,
              int graphics_count) <span class="m-label m-primary">constexpr</span></span></span>
            </h3>
            <p>Constructor.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">tiles_ref</td>
                  <td>Reference to one or more sprite tile sets.</td>
                </tr>
                <tr>
                  <td>bpp</td>
                  <td>tiles_ref bits per pixel.</td>
                </tr>
                <tr>
                  <td>compression</td>
                  <td>Compression type.</td>
                </tr>
                <tr>
                  <td>graphics_count</td>
                  <td>Number of sprite tile sets contained in tiles_ref.</td>
                </tr>
              </tbody>
            </table>
<p>The tiles are not copied but referenced, so they should outlive the <a href="classbn_1_1sprite__tiles__item.html" class="m-doc">sprite_<wbr />tiles_<wbr />item</a> to avoid dangling references.</p>
          </div></section>
          <section class="m-doc-details" id="a74b1a4546d379166790980fe2e079060"><div>
            <h3>
              <span class="m-doc-wrap-bumper">const <a href="classbn_1_1span.html" class="m-doc">span</a>&lt;const <a href="classbn_1_1tile.html" class="m-doc">tile</a>&gt;&amp; bn::<wbr />sprite_tiles_item::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a74b1a4546d379166790980fe2e079060" class="m-doc-self">tiles_ref</a>(</span><span class="m-doc-wrap">) const <span class="m-label m-primary">constexpr</span></span></span>
            </h3>
            <p>Returns the reference to one or more sprite tile sets.</p>
<p>The tiles are not copied but referenced, so they should outlive the <a href="classbn_1_1sprite__tiles__item.html" class="m-doc">sprite_<wbr />tiles_<wbr />item</a> to avoid dangling references.</p>
          </div></section>
          <section class="m-doc-details" id="af33926135d5c63445677aa2f226bddfe"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1sprite__tiles__item.html" class="m-doc">sprite_<wbr />tiles_<wbr />item</a> bn::<wbr />sprite_tiles_item::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#af33926135d5c63445677aa2f226bddfe" class="m-doc-self">decompress</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1span.html" class="m-doc">span</a>&lt;<a href="classbn_1_1tile.html" class="m-doc">tile</a>&gt; decompressed_tiles_ref) const</span></span>
            </h3>
            <p>Decompresses the stored data in the tiles referenced by decompressed_tiles_ref.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">decompressed_tiles_ref</td>
                  <td>Destination of the decompressed tiles.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>A <a href="classbn_1_1sprite__tiles__item.html" class="m-doc">sprite_<wbr />tiles_<wbr />item</a> pointing to the decompressed tiles.</td>
                </tr>
              </tfoot>
            </table>
<p>If the source and destination tiles overlap, the behavior is undefined.</p>
          </div></section>
          <section class="m-doc-details" id="a84147ffa38fcf787912fb3a13d0008f2"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a>&gt; bn::<wbr />sprite_tiles_item::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a84147ffa38fcf787912fb3a13d0008f2" class="m-doc-self">find_tiles</a>(</span><span class="m-doc-wrap">) const</span></span>
            </h3>
            <p>Searches for a <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references the first sprite tile set.</p>
            <table class="m-table m-fullwidth m-flat">
              <tfoot>
                <tr>
                  <th style="width: 1%">Returns</th>
                  <td><a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references the first sprite tile set if it has been found; <a href="namespacebn.html#a01f293535903e4c4777564a86a0f520b" class="m-doc">bn::<wbr />nullopt</a> otherwise.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="afb930f629ebb7c6a6bb044712fede3b5"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a>&gt; bn::<wbr />sprite_tiles_item::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#afb930f629ebb7c6a6bb044712fede3b5" class="m-doc-self">find_tiles</a>(</span><span class="m-doc-wrap">int graphics_index) const</span></span>
            </h3>
            <p>Searches for a <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references the sprite tile set indicated by graphics_index.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">graphics_index</td>
                  <td>Index of the tile set to search.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references the indicated sprite tile set if it has been found; <a href="namespacebn.html#a01f293535903e4c4777564a86a0f520b" class="m-doc">bn::<wbr />nullopt</a> otherwise.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="a7a9ab6344966eb9f02fad0a7d920723a"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> bn::<wbr />sprite_tiles_item::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a7a9ab6344966eb9f02fad0a7d920723a" class="m-doc-self">create_tiles</a>(</span><span class="m-doc-wrap">) const</span></span>
            </h3>
            <p>Searches for a <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references the first sprite tile set. If it is not found, it creates a <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references it.</p>
            <table class="m-table m-fullwidth m-flat">
              <tfoot>
                <tr>
                  <th style="width: 1%">Returns</th>
                  <td><a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references the first sprite tile set if it has been found; otherwise it returns a <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references it.</td>
                </tr>
              </tfoot>
            </table>
<p>The tiles are not copied but referenced, so they should outlive the <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> to avoid dangling references.</p>
          </div></section>
          <section class="m-doc-details" id="a2e53f3aee95c5e4c4e05f2c65d762658"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> bn::<wbr />sprite_tiles_item::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a2e53f3aee95c5e4c4e05f2c65d762658" class="m-doc-self">create_tiles</a>(</span><span class="m-doc-wrap">int graphics_index) const</span></span>
            </h3>
            <p>Searches for a <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references the sprite tile set indicated by graphics_index. If it is not found, it creates a <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references it.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">graphics_index</td>
                  <td>Index of the tile set to search or handle.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references the sprite tile set indicated by graphics_index if it has been found; otherwise it returns a <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references it.</td>
                </tr>
              </tfoot>
            </table>
<p>The tiles are not copied but referenced, so they should outlive the <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> to avoid dangling references.</p>
          </div></section>
          <section class="m-doc-details" id="a8e86f31d8f9062ca5d7d41cbc4b74aba"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a>&gt; bn::<wbr />sprite_tiles_item::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a8e86f31d8f9062ca5d7d41cbc4b74aba" class="m-doc-self">create_tiles_optional</a>(</span><span class="m-doc-wrap">) const</span></span>
            </h3>
            <p>Searches for a <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references the first sprite tile set. If it is not found, it creates a <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references it.</p>
            <table class="m-table m-fullwidth m-flat">
              <tfoot>
                <tr>
                  <th style="width: 1%">Returns</th>
                  <td><a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references the first sprite tile set if it has been found; otherwise it returns a new <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references it if it could be allocated; <a href="namespacebn.html#a01f293535903e4c4777564a86a0f520b" class="m-doc">bn::<wbr />nullopt</a> otherwise.</td>
                </tr>
              </tfoot>
            </table>
<p>The tiles are not copied but referenced, so they should outlive the <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> to avoid dangling references.</p>
          </div></section>
          <section class="m-doc-details" id="a96857b578fd25a0864b062b7924e293e"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a>&gt; bn::<wbr />sprite_tiles_item::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a96857b578fd25a0864b062b7924e293e" class="m-doc-self">create_tiles_optional</a>(</span><span class="m-doc-wrap">int graphics_index) const</span></span>
            </h3>
            <p>Searches for a <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references the sprite tile set indicated by graphics_index. If it is not found, it creates a <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references it.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">graphics_index</td>
                  <td>Index of the tile set to search or handle.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references the sprite tile set indicated by graphics_index if it has been found; otherwise it returns a new <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> which references it if it could be allocated; <a href="namespacebn.html#a01f293535903e4c4777564a86a0f520b" class="m-doc">bn::<wbr />nullopt</a> otherwise.</td>
                </tr>
              </tfoot>
            </table>
<p>The tiles are not copied but referenced, so they should outlive the <a href="classbn_1_1sprite__tiles__ptr.html" class="m-doc">sprite_<wbr />tiles_<wbr />ptr</a> to avoid dangling references.</p>
          </div></section>
          <section class="m-doc-details" id="ade0eefe4c5b7e63ad266afeffe0b34e0"><div>
            <h3>
              <span class="m-doc-wrap-bumper">bool </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ade0eefe4c5b7e63ad266afeffe0b34e0" class="m-doc-self">operator==</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1sprite__tiles__item.html" class="m-doc">sprite_<wbr />tiles_<wbr />item</a>&amp; a,
              const <a href="classbn_1_1sprite__tiles__item.html" class="m-doc">sprite_<wbr />tiles_<wbr />item</a>&amp; b) <span class="m-label m-primary">constexpr</span></span></span>
            </h3>
            <p>Equal operator.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">a</td>
                  <td>First <a href="classbn_1_1sprite__tiles__item.html" class="m-doc">sprite_<wbr />tiles_<wbr />item</a> to compare.</td>
                </tr>
                <tr>
                  <td>b</td>
                  <td>Second <a href="classbn_1_1sprite__tiles__item.html" class="m-doc">sprite_<wbr />tiles_<wbr />item</a> to compare.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><code>true</code> if the first <a href="classbn_1_1sprite__tiles__item.html" class="m-doc">sprite_<wbr />tiles_<wbr />item</a> is equal to the second one, otherwise <code>false</code>.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
        </section>
      </div>
    </div>
  </div>
</article></main>
<div class="m-doc-search" id="search">
  <a href="#!" onclick="return hideSearch()"></a>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-m-8 m-push-m-2">
        <div class="m-doc-search-header m-text m-small">
          <div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
          <div id="search-symbolcount">&hellip;</div>
        </div>
        <div class="m-doc-search-content">
          <form>
            <input type="search" name="q" id="search-input" placeholder="Loading &hellip;" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
          </form>
          <noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
          <div id="search-help" class="m-text m-dim m-text-center">
            <p class="m-noindent">Search for symbols, directories, files, pages or
            modules. You can omit any prefix from the symbol or file path; adding a
            <code>:</code> or <code>/</code> suffix lists all members of given symbol or
            directory.</p>
            <p class="m-noindent">Use <span class="m-label m-dim">&darr;</span>
            / <span class="m-label m-dim">&uarr;</span> to navigate through the list,
            <span class="m-label m-dim">Enter</span> to go.
            <span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
            copy a link to the result using <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">M</span> produces a Markdown link.</p>
          </div>
          <div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
          <ul id="search-results"></ul>
        </div>
      </div>
    </div>
  </div>
</div>
<script src="search-v2.js"></script>
<script src="searchdata-v2.js" async="async"></script>
<footer><nav>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <p>Butano Docs. Created with <a href="https://doxygen.org/">Doxygen</a> 1.14.0 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
      </div>
    </div>
  </div>
</nav></footer>
</body>
</html>
